home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 050 / xrefprg2.arc / XREFPRG2.DOC < prev    next >
Encoding:
Text File  |  1986-03-10  |  4.0 KB  |  112 lines
  1.  A. This utility for dBASE source code provides services which
  2.     are similar to those provided by DTUN31 and SL.  I think
  3.     that its good points are the cross reference which seems
  4.     quite good and the inclusion of the program source in the
  5.     'set'.
  6.  
  7.     I feel comfortable in praising the cross reference abilities
  8.     of the program since, unfortunately, the design of the cross
  9.     reference generator is not my code.
  10.  
  11.  B. Provides a variety of output choices
  12.  
  13.     1. Output to file - executable file (except for file name
  14.        extension '.LST'
  15.  
  16.     2. Output to file - with line numbers and/or cross reference
  17.  
  18.     3. Output to screen
  19.  
  20.     4. Output to printer
  21.  
  22.        a) Provides a page break whenever a 'procedure' is started
  23.  C. Flags key words - updated for dBASE + BUT does not include
  24.     extensions for CLIPPER or other compilers
  25.  
  26.     1. Reverse video on screen
  27.  
  28.     2. Boldface on printer
  29.  
  30.     3. Not flagged in file except for conversion to upper case
  31.  
  32.  D.  Creates constant 'case' treatment of file.  Keywords are
  33.     output in all upper case while non keywords are all lower
  34.     case.
  35.  
  36.     1. Text within quoted strings (delimited with single or double
  37.        quotes) and comments (either * or && delimited) is not
  38.        processed.
  39.  
  40.  E. Provides automatic indentation to show structure of program.
  41.     This feature is selectable and   offers the  chance to set
  42.     the amount of indenting.
  43.  
  44.     1. If 'N' is chosen at the query for auto-indent (or 'A' is not
  45.        included in the command line switches) then the file is
  46.        passed without any change in its format.
  47.  
  48.     2. Existing indentation can be removed by selecting 'Y' at the
  49.        prompt (or including 'A' in the comand line switches) and
  50.        choosing an indent level of 0.
  51.  
  52.  F. Provides a low level of source code error checking.
  53.  
  54.     1. Extra or missing 'END' statements for ENDIF, ENDDO, ENDCASE.
  55.  
  56.        a) Extra statements are indicated on both the screen and the
  57.           selected output device (as a comment) at the point
  58.           PRECEEDING the line in which  they are discovered.  It may
  59.           NOT be the correct point within the program.
  60.  
  61.        b) Missing statements are enumerated at the end of the
  62.           processing; again, the messages are both displayed on screen
  63.           and as a comment.
  64.  
  65.     2. Extra 'ELSE' statements.  These will be off whenever nested
  66.        ifs are present.
  67.  
  68.     3. Unterminated strings.  Checks for both single and double
  69.        quote delimiters.  The error message (screen and comment)
  70.        will be presented immediately following the line with the
  71.        error.
  72.  
  73.  G. Provides source file safety.  The source file is not
  74.     modified in any way.
  75.  
  76.  H. Ease of use.  All information is prompted for when the
  77.     program is invoked.  The info can also be entered in the
  78.     command line.
  79.  
  80.     1.  Basic ways to invoke the program:
  81.  
  82.        a) XREF from command line.  You will be prompted for
  83.        everything.
  84.  
  85.        b) XREF [pathname][filename].[ext]  You will be prompted for
  86.        all applicable parameters.
  87.  
  88.        c) XREF [pathname][filename].[ext] [/ { A, C, D, F, L, N,
  89.        S,0..9 } ]
  90.  
  91.             A means do auto-indenting (see 0..9 below)
  92.             C means print out in compressed mode (EPSON)
  93.             D means print out in default mode
  94.             F means print out to disk file
  95.             L means include line numbers in disk file
  96.                     This is only applicable with 'F' since using
  97.                     the screen or printer as output automatically
  98.                     include line numbers.
  99.             N means exclude the cross refernce
  100.             S means send output to the screen instead of printer.
  101.          0..9 will set the indent level to that level instead of
  102.               using the default value of (3).  This switch is used
  103.               only with 'A'.
  104.  
  105.  
  106.  
  107.  
  108.  
  109.     2. If the filename and switches are included in the command
  110.        line and the output device is a file, the output file
  111.        extension is forced to '.LST'.
  112.